//===============================================================================
// Microsoft patterns & practices
// Web Client Software Factory
//-------------------------------------------------------------------------------
// Copyright (C) Microsoft Corporation.  All rights reserved.
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY
// OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
// FITNESS FOR A PARTICULAR PURPOSE.
//-------------------------------------------------------------------------------
// The example companies, organizations, products, domain names,
// e-mail addresses, logos, people, places, and events depicted
// herein are fictitious.  No association with any real company,
// organization, product, domain name, email address, logo, person,
// places, or events is intended or should be inferred.
//===============================================================================
namespace WCSFContrib.PageFlow
{
	/// <summary>
	/// Defines the interface for a catalog of <see cref="IPageFlowDefinition"/>s.
	/// </summary>
	public interface IPageFlowDefinitionCatalog
	{
		/// <summary>
		/// Adds an <see cref="IPageFlowDefinition"/> to the catalog.
		/// </summary>
		/// <param name="definition">The <see cref="IPageFlowDefinition"/> to add to the catalog.</param>
		void Add(IPageFlowDefinition definition);
		
		/// <summary>
		/// Gets the number of <see cref="IPageFlowDefinition"/>s in the catalog.
		/// </summary>
		int Count { get; }

		/// <summary>
		/// Removes an <see cref="IPageFlowDefinition"/> from the catalog.
		/// </summary>
		/// <param name="definition">The <see cref="IPageFlowDefinition"/> to remove.</param>
		void Remove(IPageFlowDefinition definition);

		/// <summary>
		/// Gets an <see cref="IPageFlowDefinition"/> based on its URL.
		/// </summary>
		/// <param name="rawUrl">The URL that designates the <see cref="IPageFlowDefinition"/> to retrieve.</param>
		/// <returns>The <see cref="IPageFlowDefinition"/> for the given URL.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings", MessageId = "0#")]
        IPageFlowDefinition GetByUrl(string rawUrl);
	}
}
